<!DOCTYPE html><html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>phpDocumentor » \CommanderLogger</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">phpDocumentor</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
                                    API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li>
<li><a href="../packages/ActiveRecord.html"><i class="icon-folder-open"></i> ActiveRecord</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
                                    Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
                                    Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
                <span class="label label-info">310</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
                <ul><li>todo 
                <span class="label label-info">5</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
                <span class="label label-info">3</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
                            Javascript is disabled; several features are only available
                            if Javascript is enabled.
                        </div></noscript>
<div class="row">
<div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods
                    <ul>
<li class="method public "><a href="#method_error_log" title="error_log :: Registra un mensaje de tipo ERROR en un archivo log"><span class="description">Registra un mensaje de tipo ERROR en un archivo log</span><pre>error_log()</pre></a></li>
<li class="method public "><a href="#method_fatal_log" title="fatal_log :: Registra un mensaje de tipo ERROR FATAL en un archivo log"><span class="description">Registra un mensaje de tipo ERROR FATAL en un archivo log</span><pre>fatal_log()</pre></a></li>
<li class="method public "><a href="#method_jump_log" title="jump_log :: Registra un salto de linea y separacion en el archivo log registrado"><span class="description">Registra un salto de linea y separacion en el archivo log registrado</span><pre>jump_log()</pre></a></li>
<li class="method public "><a href="#method_log" title="log :: Registra un mensaje con el tipo especificado y en el archivo log indicado,
si el archivo no se indica se crea uno por defecto con la fecha actual"><span class="description">Registra un mensaje con el tipo especificado y en el archivo log indicado,
si el archivo no se indica se crea uno por defecto con la fecha actual</span><pre>log()</pre></a></li>
<li class="method public "><a href="#method_notice_log" title="notice_log :: Registra un mensaje de tipo NOTICE en un archivo log"><span class="description">Registra un mensaje de tipo NOTICE en un archivo log</span><pre>notice_log()</pre></a></li>
<li class="method public "><a href="#method_open_log" title='open_log :: Abre el archivo log especificado en modo "append" es decir,
si no existe lo crea y si existe lo abre para empezar a escribir al final'><span class="description">Abre el archivo log especificado en modo "append" es decir,
si no existe lo crea y si existe lo abre para empezar a escribir al final</span><pre>open_log()</pre></a></li>
<li class="method public "><a href="#method_warning_log" title="warning_log :: Registra un mensaje de tipo WARNING o alerta en un archivo log"><span class="description">Registra un mensaje de tipo WARNING o alerta en un archivo log</span><pre>warning_log()</pre></a></li>
</ul>
</li>
<li class="nav-header private">» Private
                    <ul>
<li class="method private "><a href="#method_close_log" title="close_log :: Cierra un archivo log previamente abierto"><span class="description">Cierra un archivo log previamente abierto</span><pre>close_log()</pre></a></li>
<li class="method private "><a href="#method_get_log_path" title="get_log_path :: Obtiene la ruta absoluta del archivo log a construir, baado en la
configuracion y el nombre especificado, si el nombre no se especifica retorna
la ruta para un log con la fecha actual"><span class="description">Obtiene la ruta absoluta del archivo log a construir, baado en la
configuracion y el nombre especificado, si el nombre no se especifica retorna
la ruta para un log con la fecha actual</span><pre>get_log_path()</pre></a></li>
<li class="method private "><a href="#method_write_log" title="write_log :: Guarda el mensaje especificado en un archivo log previamente abierto"><span class="description">Guarda el mensaje especificado en un archivo log previamente abierto</span><pre>write_log()</pre></a></li>
</ul>
</li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties
                    <ul></ul>
</li>
<li class="nav-header private">» Private
                    <ul>
<li class="property private "><a href="#property_file_pointer" title="$file_pointer :: "><span class="description">Es el puntero al archivo log cuando este ha sido abierto para escritura</span><pre>$file_pointer</pre></a></li>
<li class="property private "><a href="#property_path" title="$path :: "><span class="description">Indica la ruta del directorio de archivos logs, viene predefinida en el core.php con la constante LOGS_PATH</span><pre>$path</pre></a></li>
<li class="property private "><a href="#property_tipo" title="$tipo :: "><span class="description">Arreglo asociativo con los tipos de mensajes soportados por la clase logger</span><pre>$tipo</pre></a></li>
</ul>
</li>
</ul>
</div>
<div class="span8">
<a id="\CommanderLogger"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li><a href="../namespaces/global.html">global</a></li>
<li class="active">
<span class="divider">\</span><a href="../classes/CommanderLogger.html">CommanderLogger</a>
</li>
</ul>
<div class="element class">
<p class="short_description">Clase logger del frame, registra mensajes del sistema en archivos logs</p>
<div class="details">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>author</th>
<td><a href="mailto:bobbabilon2@gmail.com">Robert Babilonia</a></td>
</tr></table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a id="method_error_log"></a><div class="element clickable method public method_error_log" data-toggle="collapse" data-target=".method_error_log .collapse">
<h2>Registra un mensaje de tipo ERROR en un archivo log</h2>
<pre>error_log(string $message, string $logfile) </pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$message</h4>
<code>string</code><p>Mensaje a registrar</p></div>
<div class="subelement argument">
<h4>$logfile</h4>
<code>string</code><p>Archivo log a escribir</p></div>
</div></div>
</div>
<a id="method_fatal_log"></a><div class="element clickable method public method_fatal_log" data-toggle="collapse" data-target=".method_fatal_log .collapse">
<h2>Registra un mensaje de tipo ERROR FATAL en un archivo log</h2>
<pre>fatal_log(string $message, string $logfile) </pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$message</h4>
<code>string</code><p>Mensaje a registrar</p></div>
<div class="subelement argument">
<h4>$logfile</h4>
<code>string</code><p>Archivo log a escribir</p></div>
</div></div>
</div>
<a id="method_jump_log"></a><div class="element clickable method public method_jump_log" data-toggle="collapse" data-target=".method_jump_log .collapse">
<h2>Registra un salto de linea y separacion en el archivo log registrado</h2>
<pre>jump_log(string $logfile) </pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$logfile</h4>
<code>string</code><p>Achivo log a esribir</p></div>
</div></div>
</div>
<a id="method_log"></a><div class="element clickable method public method_log" data-toggle="collapse" data-target=".method_log .collapse">
<h2>Registra un mensaje con el tipo especificado y en el archivo log indicado,
si el archivo no se indica se crea uno por defecto con la fecha actual</h2>
<pre>log(string $message, \strting $messageType, string $logfile) </pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$message</h4>
<code>string</code><p>Cadena con el mensaje a registrar</p></div>
<div class="subelement argument">
<h4>$messageType</h4>
<code>\strting</code><p>Tipo de mensaje a crear, los soportados: NOTICE, WARNING, ERROR, FATAL</p></div>
<div class="subelement argument">
<h4>$logfile</h4>
<code>string</code><p>Nombre del archivo log a crear,si no se especifica crea un archivo con la fecha actual</p></div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="../classes/CommanderException.html">\CommanderException</a></code></th>
<td></td>
</tr></table>
</div></div>
</div>
<a id="method_notice_log"></a><div class="element clickable method public method_notice_log" data-toggle="collapse" data-target=".method_notice_log .collapse">
<h2>Registra un mensaje de tipo NOTICE en un archivo log</h2>
<pre>notice_log(string $message, string $logfile) </pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$message</h4>
<code>string</code><p>Mensaje a registrar</p></div>
<div class="subelement argument">
<h4>$logfile</h4>
<code>string</code><p>Archivo log a escribir</p></div>
</div></div>
</div>
<a id="method_open_log"></a><div class="element clickable method public method_open_log" data-toggle="collapse" data-target=".method_open_log .collapse">
<h2>Abre el archivo log especificado en modo "append" es decir,
si no existe lo crea y si existe lo abre para empezar a escribir al final</h2>
<pre>open_log(string $logfile) </pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$logfile</h4>
<code>string</code>
</div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="../classes/CommanderException.html">\CommanderException</a></code></th>
<td></td>
</tr></table>
</div></div>
</div>
<a id="method_warning_log"></a><div class="element clickable method public method_warning_log" data-toggle="collapse" data-target=".method_warning_log .collapse">
<h2>Registra un mensaje de tipo WARNING o alerta en un archivo log</h2>
<pre>warning_log(string $message, string $logfile) </pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$message</h4>
<code>string</code><p>Mensaje a registrar</p></div>
<div class="subelement argument">
<h4>$logfile</h4>
<code>string</code><p>Archivo log a escribir</p></div>
</div></div>
</div>
<a id="method_close_log"></a><div class="element clickable method private method_close_log" data-toggle="collapse" data-target=".method_close_log .collapse">
<h2>Cierra un archivo log previamente abierto</h2>
<pre>close_log() </pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="method_get_log_path"></a><div class="element clickable method private method_get_log_path" data-toggle="collapse" data-target=".method_get_log_path .collapse">
<h2>Obtiene la ruta absoluta del archivo log a construir, baado en la
configuracion y el nombre especificado, si el nombre no se especifica retorna
la ruta para un log con la fecha actual</h2>
<pre>get_log_path(string $logfile) : string</pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$logfile</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>path</div>
</div></div>
</div>
<a id="method_write_log"></a><div class="element clickable method private method_write_log" data-toggle="collapse" data-target=".method_write_log .collapse">
<h2>Guarda el mensaje especificado en un archivo log previamente abierto</h2>
<pre>write_log(string $message) </pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$message</h4>
<code>string</code><p>Mensaje a guardar en el archivo log</p></div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="../classes/CommanderException.html">\CommanderException</a></code></th>
<td></td>
</tr></table>
</div></div>
</div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a id="property_file_pointer"> </a><div class="element clickable property private property_file_pointer" data-toggle="collapse" data-target=".property_file_pointer .collapse">
<h2>Es el puntero al archivo log cuando este ha sido abierto para escritura</h2>
<pre>$file_pointer : \pointer</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="property_path"> </a><div class="element clickable property private property_path" data-toggle="collapse" data-target=".property_path .collapse">
<h2>Indica la ruta del directorio de archivos logs, viene predefinida en el core.php con la constante LOGS_PATH</h2>
<pre>$path : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="property_tipo"> </a><div class="element clickable property private property_tipo" data-toggle="collapse" data-target=".property_tipo .collapse">
<h2>Arreglo asociativo con los tipos de mensajes soportados por la clase logger</h2>
<pre>$tipo : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
            Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
            Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a12</a> and<br>
            generated on 2013-06-08T13:56:19-04:30.<br></footer></div>
</div>
</body>
</html>
